SureTax Returns API

GET FormInstanceTaxItems

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

OperationId: GET FormInstanceTaxItems

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/FormInstanceTaxItems

Query Parameters

Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

Display String	Field Name	Field Type
Form Instance Id*	formInstanceId	string

*Mandatory parameter

FormInstanceTaxItemsParentResponse

OVERVIEWEXAMPLE

Overview

Parent response containing form instance tax items.

FormInstanceTaxItemsParentResponse

Display Name	Field Name	Field Type
Data	data	array[FormInstanceTaxItemsResponse]

FormInstanceTaxItemsResponse

Display Name	Field Name	Field Type
Form Instance Id	formInstanceId	string
Taxable Item Id	taxableItemId	string
Tax Item Id	taxItemId	string

Example Response

The following is an example response you can expect for this operation

{
  "data": [
    {
      "formInstanceId": "d15cf1c8-2094-4fd2-802b-ce7eddf9b567",
      "taxableItemId": "TAXABLE-001",
      "taxItemId": "1"
    }
  ]
}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	Success Response - 200 OK. Returns form instance tax data for the given input.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/FormInstanceTaxItems

Add Request Headers: